Filter hook 'rest_{$this->taxonomy}_collection_params'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into rest_{$this->taxonomy}_collection_params
add_filter('rest_{$this->taxonomy}_collection_params', 'my_custom_filter', 10, 2);

function my_custom_filter($query_params, $taxonomy) {
    // Your custom filtering logic here
    return $query_params;
}

Source Code Context

<?php
1220  		 * @since 4.7.0
1221  		 *
1222  		 * @param array       $query_params JSON Schema-formatted collection parameters.
1223  		 * @param WP_Taxonomy $taxonomy     Taxonomy object.
1224  		 */
1225  		return apply_filters( "rest_{$this->taxonomy}_collection_params", $query_params, $taxonomy );
1226  	}
1227  
1228  	/**
1229  	 * Checks that the taxonomy is valid.
1230  	 *

PHP Documentation

<?php
/**
		 * Filters collection parameters for the terms controller.
		 *
		 * The dynamic part of the filter `$this->taxonomy` refers to the taxonomy
		 * slug for the controller.
		 *
		 * This filter registers the collection parameter, but does not map the
		 * collection parameter to an internal WP_Term_Query parameter.  Use the
		 * `rest_{$this->taxonomy}_query` filter to set WP_Term_Query parameters.
		 *
		 * @since 4.7.0
		 *
		 * @param array       $query_params JSON Schema-formatted collection parameters.
		 * @param WP_Taxonomy $taxonomy     Taxonomy object.
		 */